<!DOCTYPE html>
<html lang="en">
  <head>
    <title>Classes  Reference</title>
    <link rel="stylesheet" type="text/css" href="css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="css/highlight.css" />
    <meta charset='utf-8'>
    <script src="js/jquery.min.js" defer></script>
    <script src="js/jazzy.js" defer></script>
    
  </head>
  <body>
    <a title="Classes  Reference"></a>
    <header>
      <div class="content-wrapper">
        <p><a href="index.html">SwipeCellKit Docs</a> (100% documented)</p>
        <p class="header-right"><a href="https://github.com/SwipeCellKit/SwipeCellKit"><img src="img/gh.png"/>View on GitHub</a></p>
      </div>
    </header>
    <div class="content-wrapper">
      <p id="breadcrumbs">
        <a href="index.html">SwipeCellKit Reference</a>
        <img id="carat" src="img/carat.png" />
        Classes  Reference
      </p>
    </div>
    <div class="content-wrapper">
      <nav class="sidebar">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a href="Guides.html">Guides</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="advanced.html">Advanced</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Classes.html">Classes</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Classes/SwipeAction.html">SwipeAction</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/SwipeCollectionViewCell.html">SwipeCollectionViewCell</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/SwipeTableViewCell.html">SwipeTableViewCell</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Enums.html">Enumerations</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Enums/ExpansionFulfillmentStyle.html">ExpansionFulfillmentStyle</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/SwipeActionStyle.html">SwipeActionStyle</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/SwipeActionsOrientation.html">SwipeActionsOrientation</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/SwipeTransitionStyle.html">SwipeTransitionStyle</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/SwipeVerticalAlignment.html">SwipeVerticalAlignment</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Protocols.html">Protocols</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Protocols/SwipeActionTransitioning.html">SwipeActionTransitioning</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/SwipeCollectionViewCellDelegate.html">SwipeCollectionViewCellDelegate</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/SwipeExpanding.html">SwipeExpanding</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/SwipeTableViewCellDelegate.html">SwipeTableViewCellDelegate</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Structs.html">Structures</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Structs/ScaleAndAlphaExpansion.html">ScaleAndAlphaExpansion</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/ScaleTransition.html">ScaleTransition</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/SwipeActionTransitioningContext.html">SwipeActionTransitioningContext</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/SwipeExpansionAnimationTimingParameters.html">SwipeExpansionAnimationTimingParameters</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/SwipeExpansionStyle.html">SwipeExpansionStyle</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/SwipeExpansionStyle/Target.html">– Target</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/SwipeExpansionStyle/Trigger.html">– Trigger</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/SwipeExpansionStyle/CompletionAnimation.html">– CompletionAnimation</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/SwipeExpansionStyle/FillOptions.html">– FillOptions</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/SwipeOptions.html">SwipeOptions</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">
        <section>
          <section class="section">
            <h1>Classes</h1>
            <p>The following classes are available globally.</p>

          </section>
          <section class="section task-group-section">
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/c:@M@SwipeCellKit@objc(cs)SwipeAction"></a>
                    <a name="//apple_ref/swift/Class/SwipeAction" class="dashAnchor"></a>
                    <a class="token" href="#/c:@M@SwipeCellKit@objc(cs)SwipeAction">SwipeAction</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>The <code>SwipeAction</code> object defines a single action to present when the user swipes horizontally in a table/collection item.</p>

<p>This class lets you define one or more custom actions to display for a given item in your table/collection. Each instance of this class represents a single action to perform and includes the text, formatting information, and behavior for the corresponding button.</p>

                        <a href="Classes/SwipeAction.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">SwipeAction</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/c:@M@SwipeCellKit@objc(cs)SwipeCollectionViewCell"></a>
                    <a name="//apple_ref/swift/Class/SwipeCollectionViewCell" class="dashAnchor"></a>
                    <a class="token" href="#/c:@M@SwipeCellKit@objc(cs)SwipeCollectionViewCell">SwipeCollectionViewCell</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>The <code>SwipeCollectionViewCell</code> class extends <code>UICollectionViewCell</code> and provides more flexible options for cell swiping behavior.</p>

<p>The default behavior closely matches the stock Mail.app. If you want to customize the transition style (ie. how the action buttons are exposed), or the expansion style (the behavior when the row is swiped passes a defined threshold), you can return the appropriately configured <code><a href="Structs/SwipeOptions.html">SwipeOptions</a></code> via the <code><a href="Protocols/SwipeCollectionViewCellDelegate.html">SwipeCollectionViewCellDelegate</a></code> delegate.</p>

                        <a href="Classes/SwipeCollectionViewCell.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">SwipeCollectionViewCell</span><span class="p">:</span> <span class="kt">UICollectionViewCell</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/c:@M@SwipeCellKit@objc(cs)SwipeTableViewCell"></a>
                    <a name="//apple_ref/swift/Class/SwipeTableViewCell" class="dashAnchor"></a>
                    <a class="token" href="#/c:@M@SwipeCellKit@objc(cs)SwipeTableViewCell">SwipeTableViewCell</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>The <code>SwipeTableViewCell</code> class extends <code>UITableViewCell</code> and provides more flexible options for cell swiping behavior.</p>

<p>The default behavior closely matches the stock Mail.app. If you want to customize the transition style (ie. how the action buttons are exposed), or the expansion style (the behavior when the row is swiped passes a defined threshold), you can return the appropriately configured <code><a href="Structs/SwipeOptions.html">SwipeOptions</a></code> via the <code><a href="Protocols/SwipeTableViewCellDelegate.html">SwipeTableViewCellDelegate</a></code> delegate.</p>

                        <a href="Classes/SwipeTableViewCell.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">SwipeTableViewCell</span><span class="p">:</span> <span class="kt">UITableViewCell</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </section>
        </section>
        <section id="footer">
          <p>&copy; 2018 <a class="link" href="https://twitter.com/mkurabi" target="_blank" rel="external">Mohammad Kurabi</a>. All rights reserved. (Last updated: 2018-05-26)</p>
          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
        </section>
      </article>
    </div>
  </body>
</div>
</html>
